/**
 * Copyright (c) 2013-2022, Alibaba Group Holding Limited;
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * </p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.aliyun.polardbx.rpl.extractor.flashback;

import java.io.File;
import java.util.List;

/**
 * @author ziyang.lb
 */
public interface IBinlogFileQueue {

    /**
     * Get the file after pre in the queue.
     */
    File getNextFile(File pre);

    /**
     * Get the file before pre in the queue.
     */
    File getBefore(File file);

    /**
     * Wait until the file after pre in the queue is ready, then return the file.
     */
    File waitForNextFile(File pre) throws InterruptedException;

    /**
     * Return the first file in the queue.
     */
    File getFirstFile();

    /**
     * Destroy the queue.
     */
    void destroy();

    /**
     * List all the binlog files in the directory.
     */
    List<File> listBinlogFiles();
}
